Skip to content

Expose GitHub summary unconditionally #821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 16, 2025

Conversation

jprinet
Copy link
Member

@jprinet jprinet commented Apr 10, 2025

Issue

The GitHub summary is not published when the validation scripts run as part of the GiHub composite actions fail.

Fix

The validation scripts are run within a bash step which is by default configured to exit immediately upon command failure

set -e

The fix is to revert this configuration and capture the validation script exit code to allow post actions within the step (build scan links capture and receipt file renaming)
Subsequent steps to archive the receipt and inline it in the summary are configured to run unconditionnally

if: always()

Implementation details

  • The receipt file is renamed to a predictable receipt.txt file to avoid passing the filename across steps and adding an attack surface as the file content is archived and inlined in the GitHub summary
  • the upload-artifact step is using the default configuration which triggers a warning message when the receipt file is not present. This is an interesting information for the action consumer.

@jprinet jprinet requested a review from erichaagdev April 10, 2025 10:04
Copy link
Member

@erichaagdev erichaagdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 minor non-blocking suggestion.

Comment on lines 125 to 129
# Copy receipt to a predictable location
RECEIPT_FILE=".data/01-validate-incremental-building/latest/exp1-*.receipt"
if [ -f ${RECEIPT_FILE} ]; then
cp ${RECEIPT_FILE} ../receipt.txt
fi
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about something like this?

Suggested change
# Copy receipt to a predictable location
RECEIPT_FILE=".data/01-validate-incremental-building/latest/exp1-*.receipt"
if [ -f ${RECEIPT_FILE} ]; then
cp ${RECEIPT_FILE} ../receipt.txt
fi
echo "receiptFile=$(readlink -f .data/01-validate-incremental-building/latest/exp1-*.receipt)" >> $GITHUB_OUTPUT

That way we don't have to copy files around to be used in a later step. I think that would also allow users to consume it and could write the file contents to Slack or an email or something without having to worry about where the file is located. I think that's true anyway.

Then later we can do:

if [ -f "${{ steps.run.outputs.receiptFile }}" ]; then
...
fi

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To expose the file outside of the composite action, we would also need to declare it as an extra output there.
We could do that but my intention is exactly opposite as described there

The receipt file is renamed to a predictable receipt.txt file to avoid passing the filename across steps and adding an attack surface as the file content is archived and inlined in the GitHub summary

We also could keep the reference .data/01-validate-incremental-building/latest/exp1-*.receipt in the 3 different steps to avoid the copy
The copy is just there to avoid repeating the uneasy reference.
Do you think it would be better?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To expose the file outside of the composite action, we would also need to declare it as an extra output there.

Right, I knew there was something I was missing. I would do that.

adding an attack surface as the file content is archived and inlined in the GitHub summary

I don't get this part.

Copy link
Member Author

@jprinet jprinet Apr 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having as a step input a file path which you then display in the summary and upload as an artifact is something I am a bit reluctant to do
I see this as a way to display content of a file which was not meant to be displayed in the first place

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, but I still don't understand. We already displayed the content in the summary before here.

And the file was an input to the upload action here.

path: develocity-gradle-build-validation/.data/01-validate-incremental-building/latest*/exp1-*.receipt

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The artifact is uploaded immediately after the experiment completes in the following step and the summary is written immediately after that. All of this happens within the composite action so the user can overwrite the file, but neither the uploaded artifact or experiment summary should be affected.

In any case, they could have overwritten the file before these changes too.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that the risk is limited or not worsened but I still feel it is bad practice to display a file content without controlling how the file path is obtained

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is your concern only about exposing the file path to the user, i.e., adding it as an output of the composite action?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My concern is that the composite step is displaying a file which could potentially be something else than the report.
You could think of a scenario with a complex consuming workflow, calling this composite, with maintainers thoroughly checking that files with secrets are not undisclosed by a PR, but omitting to control the behavior of steps brought by composite actions.
This is unlikely to happen but not impossible if we make the receipt file a step input/output

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We agreed on a call to inline the full receipt path when used

@jprinet jprinet force-pushed the jprinet/publish-github-action-summary-unconditionnally branch from f1665e1 to 1674631 Compare April 16, 2025 07:45
@jprinet jprinet merged commit 7229ea9 into main Apr 16, 2025
4 checks passed
@jprinet jprinet deleted the jprinet/publish-github-action-summary-unconditionnally branch April 16, 2025 08:29

# Set the Build Scan urls as outputs
RECEIPT_FILE=".data/01-validate-incremental-building/latest/exp1-*.receipt"
BUILD_SCAN_1=$(grep -m 1 "first build" ${RECEIPT_FILE} | sed 's/.* //')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't RECEIPT_FILE undefined now?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

damned, I missed this one, good catch. I'll fix it in another PR

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could just move the capturing of build scan links to the Fill GitHub summary step inside of the if condition such that the final thing done in this step is the script invocation. That would also allow you to remove the set +e and capturing of the exit code.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense and will put altogether the GitHub I/O in the same step 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants